/*
 * Copyright (c) 2025 Huawei Device Co., Ltd.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/**
 * @addtogroup CryptoKdfApi
 * @{
 *
 * @brief 为应用提供密钥派生函数（KDF）接口。
 *
 * @since 20
 */

/**
 * @file crypto_kdf.h
 *
 * @brief 定义密钥派生接口。
 *
 * @library libohcrypto.so
 * @include <CryptoArchitectureKit/crypto_kdf.h>
 * @kit CryptoArchitectureKit
 * @syscap SystemCapability.Security.CryptoFramework
 * @since 20
 */

#ifndef CRYPTO_KDF_H
#define CRYPTO_KDF_H

#include "crypto_common.h"

#ifdef __cplusplus
extern "C" {
#endif

/**
 * @brief 定义密钥派生函数（KDF）结构。
 *
 * @since 20
 */
typedef struct OH_CryptoKdf OH_CryptoKdf;

/**
 * @brief 定义密钥派生函数（KDF）参数结构。
 *
 * @since 20
 */
typedef struct OH_CryptoKdfParams OH_CryptoKdfParams;

/**
 * @brief 定义密钥派生函数（KDF）参数类型。
 *
 * @since 20
 */
typedef enum {
    /** 表示KDF的密钥或密码。 */
    CRYPTO_KDF_KEY_DATABLOB = 0,

    /** 表示KDF的盐值。 */
    CRYPTO_KDF_SALT_DATABLOB = 1,

    /** 表示KDF的信息。 */
    CRYPTO_KDF_INFO_DATABLOB = 2,

    /** 表示PBKDF2的迭代次数。 */
    CRYPTO_KDF_ITER_COUNT_INT = 3,

    /** 表示SCRYPT KDF的n参数。 */
    CRYPTO_KDF_SCRYPT_N_UINT64 = 4,

    /** 表示SCRYPT KDF的r参数。 */
    CRYPTO_KDF_SCRYPT_R_UINT64 = 5,

    /** 表示SCRYPT KDF的p参数。 */
    CRYPTO_KDF_SCRYPT_P_UINT64 = 6,

    /** 表示SCRYPT KDF的最大内存使用量。 */
    CRYPTO_KDF_SCRYPT_MAX_MEM_UINT64 = 7,
} CryptoKdf_ParamType;

/**
 * @brief 创建密钥派生函数（KDF）参数。
 *
 * @param algoName KDF算法名称。\n
 * 例如"HKDF|SHA384|EXTRACT_AND_EXPAND"、"PBKDF2|SHA384"。
 * @param params KDF参数。
 * @return CRYPTO_SUCCESS：操作成功。\n
 *         CRYPTO_NOT_SUPPORTED：操作不支持。\n
 *         CRYPTO_MEMORY_ERROR：内存错误。\n
 *         CRYPTO_PARAMETER_CHECK_FAILED：参数检查失败。\n
 *         CRYPTO_OPERTION_ERROR：调用三方算法库API出错。
 * @since 20
 */
OH_Crypto_ErrCode OH_CryptoKdfParams_Create(const char *algoName, OH_CryptoKdfParams **params);

/**
 * @brief 设置密钥派生函数（KDF）参数。
 *
 * @param params KDF参数。
 * @param type KDF参数类型。
 * @param value KDF参数值。
 * @return CRYPTO_SUCCESS：操作成功。\n
 *         CRYPTO_NOT_SUPPORTED：操作不支持。\n
 *         CRYPTO_MEMORY_ERROR：内存错误。\n
 *         CRYPTO_PARAMETER_CHECK_FAILED：参数检查失败。\n
 *         CRYPTO_OPERTION_ERROR：调用三方算法库API出错。
 * @since 20
 */
OH_Crypto_ErrCode OH_CryptoKdfParams_SetParam(OH_CryptoKdfParams *params, CryptoKdf_ParamType type,
    Crypto_DataBlob *value);

/**
 * @brief 销毁密钥派生函数（KDF）参数。
 *
 * @param params KDF参数。
 * @since 20
 */
void OH_CryptoKdfParams_Destroy(OH_CryptoKdfParams *params);

/**
 * @brief 创建密钥派生函数（KDF）实例。
 *
 * @param algoName KDF算法名称。
 * @param ctx KDF实例。
 * @return CRYPTO_SUCCESS：操作成功。\n
 *         CRYPTO_NOT_SUPPORTED：操作不支持。\n
 *         CRYPTO_MEMORY_ERROR：内存错误。\n
 *         CRYPTO_PARAMETER_CHECK_FAILED：参数检查失败。\n
 *         CRYPTO_OPERTION_ERROR：调用三方算法库API出错。
 * @since 20
 */
OH_Crypto_ErrCode OH_CryptoKdf_Create(const char *algoName, OH_CryptoKdf **ctx);

/**
 * @brief 派生密钥。
 *
 * @param ctx KDF实例。
 * @param params KDF参数。
 * @param keyLen 密钥派生长度。
 * @param key 派生出的密钥。
 * @return CRYPTO_SUCCESS：操作成功。\n
 *         CRYPTO_NOT_SUPPORTED：操作不支持。\n
 *         CRYPTO_MEMORY_ERROR：内存错误。\n
 *         CRYPTO_PARAMETER_CHECK_FAILED：参数检查失败。\n
 *         CRYPTO_OPERTION_ERROR：调用三方算法库API出错。
 * @since 20
 */
OH_Crypto_ErrCode OH_CryptoKdf_Derive(OH_CryptoKdf *ctx, const OH_CryptoKdfParams *params, int keyLen,
    Crypto_DataBlob *key);

/**
 * @brief 销毁密钥派生函数（KDF）实例。
 *
 * @param ctx KDF实例。
 * @since 20
 */
void OH_CryptoKdf_Destroy(OH_CryptoKdf *ctx);

#ifdef __cplusplus
}
#endif

#endif /* CRYPTO_KDF_H */
/** @} */
